Декоратори JavaScript для валідації параметрів: Забезпечення цілісності даних

У сучасній розробці на JavaScript забезпечення цілісності даних, що передаються у функції та методи, є першочерговим завданням. Одним із потужних методів для досягнення цього є використання декораторів для валідації параметрів. Декоратори, функція, доступна в JavaScript через Babel або нативно в TypeScript, надають чистий та елегантний спосіб додавати функціональність до функцій, класів та властивостей. Ця стаття заглиблюється у світ декораторів JavaScript, зосереджуючись на їх застосуванні в перевірці аргументів, пропонуючи практичні приклади та ідеї для розробників усіх рівнів.

Що таке декоратори JavaScript?

Декоратори — це патерн проєктування, який дозволяє динамічно та статично додавати поведінку до існуючого класу, функції або властивості. По суті, вони "декорують" існуючий код новою функціональністю, не змінюючи сам оригінальний код. Це відповідає принципу відкритості/закритості (Open/Closed Principle) з SOLID, який стверджує, що програмні сутності (класи, модулі, функції тощо) повинні бути відкритими для розширення, але закритими для модифікації.

У JavaScript декоратори — це спеціальний вид оголошення, який можна приєднати до оголошення класу, методу, аксесора, властивості або параметра. Вони використовують синтаксис @expression, де expression має повертати функцію, яка буде викликана під час виконання з інформацією про декороване оголошення.

Щоб використовувати декоратори в JavaScript, зазвичай потрібно використовувати транспайлер, такий як Babel з увімкненим плагіном @babel/plugin-proposal-decorators. TypeScript підтримує декоратори нативно.

Переваги використання декораторів для валідації параметрів

Використання декораторів для валідації параметрів пропонує кілька переваг:

• Покращена читабельність коду: Декоратори надають декларативний спосіб вираження правил валідації, що робить код легшим для розуміння та підтримки.
• Зменшення шаблонного коду: Замість повторення логіки валідації в кількох функціях, декоратори дозволяють визначити її один раз і застосовувати по всьому коду.
• Покращене повторне використання коду: Декоратори можна повторно використовувати в різних класах і функціях, що сприяє повторному використанню коду та зменшує надлишковість.
• Розділення відповідальностей: Логіка валідації відокремлена від основної бізнес-логіки функції, що призводить до чистішого та більш модульного коду.
• Централізована логіка валідації: Усі правила валідації визначені в одному місці, що полегшує їх оновлення та підтримку.

Реалізація валідації параметрів за допомогою декораторів

Давайте розглянемо, як реалізувати валідацію параметрів за допомогою декораторів JavaScript. Ми почнемо з простого прикладу, а потім перейдемо до більш складних сценаріїв.

Базовий приклад: валідація строкового параметра

Розглянемо функцію, яка очікує строковий параметр. Ми можемо створити декоратор, щоб переконатися, що параметр дійсно є рядком.

function validateString(target: any, propertyKey: string | symbol, parameterIndex: number) {
  let existingParameters: any[] = Reflect.getOwnMetadata('validateParameters', target, propertyKey) || [];
  existingParameters.push({ index: parameterIndex, validator: (value: any) => typeof value === 'string' });
  Reflect.defineMetadata('validateParameters', existingParameters, target, propertyKey);

  const originalMethod = target[propertyKey];

  target[propertyKey] = function (...args: any[]) {
    const metadata = Reflect.getOwnMetadata('validateParameters', target, propertyKey);

    if (metadata) {
      for (const item of metadata) {
        const { index, validator } = item;
        if (!validator(args[index])) {
          throw new Error(`Parameter at index ${index} is invalid`);
        }
      }
    }

    return originalMethod.apply(this, args);
  };
}

function validate(...validators: ((value: any) => boolean)[]) {
  return function (target: any, propertyKey: string | symbol, descriptor: PropertyDescriptor) {
    const originalMethod = descriptor.value;

    descriptor.value = function (...args: any[]) {
      for (let i = 0; i < validators.length; i++) {
        if (!validators[i](args[i])) {
          throw new Error(`Parameter at index ${i} is invalid`);
        }
      }
      return originalMethod.apply(this, args);
    };
  };
}


function isString(value: any): boolean {
  return typeof value === 'string';
}

class Example {
  @validate(isString)
  greet( @validateString name: string) {
    return `Hello, ${name}!`;
  }
}

const example = new Example();

try {
  console.log(example.greet("Alice")); // Output: Hello, Alice!
  // example.greet(123); // Throws an error
} catch (error:any) {
  console.error(error.message);
}

Пояснення:

• Декоратор validateString застосовується до параметра name методу greet.
• Він використовує Reflect.defineMetadata та Reflect.getOwnMetadata для зберігання та отримання метаданих валідації, пов'язаних з методом.
• Перед викликом оригінального методу він перебирає метадані валідації та застосовує функцію валідатора до кожного параметра.
• Якщо будь-який параметр не проходить валідацію, виникає помилка.
• Декоратор validate надає більш загальний та композитний спосіб застосування валідаторів до параметрів, дозволяючи вказувати декілька валідаторів для кожного параметра.
• Функція isString є простим валідатором, який перевіряє, чи є значення рядком.
• Клас Example демонструє, як використовувати декоратори для валідації параметра name методу greet.

Просунутий приклад: валідація формату email

Створімо декоратор для перевірки, чи є строковий параметр дійсною email-адресою.

function validateEmail(target: any, propertyKey: string | symbol, parameterIndex: number) {
  let existingParameters: any[] = Reflect.getOwnMetadata('validateParameters', target, propertyKey) || [];
  existingParameters.push({ index: parameterIndex, validator: (value: any) => {
    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
    return typeof value === 'string' && emailRegex.test(value);
  } });
  Reflect.defineMetadata('validateParameters', existingParameters, target, propertyKey);

  const originalMethod = target[propertyKey];

  target[propertyKey] = function (...args: any[]) {
    const metadata = Reflect.getOwnMetadata('validateParameters', target, propertyKey);

    if (metadata) {
      for (const item of metadata) {
        const { index, validator } = item;
        if (!validator(args[index])) {
          throw new Error(`Parameter at index ${index} is not a valid email address`);
        }
      }
    }

    return originalMethod.apply(this, args);
  };
}

class User {
  register( @validateEmail email: string) {
    return `Registered with email: ${email}`; 
  }
}

const user = new User();

try {
  console.log(user.register("test@example.com")); // Output: Registered with email: test@example.com
  // user.register("invalid-email"); // Throws an error
} catch (error:any) {
  console.error(error.message);
}

Пояснення:

• Декоратор validateEmail використовує регулярний вираз для перевірки, чи є параметр дійсною email-адресою.
• Якщо параметр не є дійсною email-адресою, виникає помилка.

Комбінування декількох валідаторів

Ви можете комбінувати декілька валідаторів, використовуючи декоратор validate та власні функції валідаторів.

function isNotEmptyString(value: any): boolean {
  return typeof value === 'string' && value.trim() !== '';
}

function isPositiveNumber(value: any): boolean {
  return typeof value === 'number' && value > 0;
}

class Product {
  @validate(isNotEmptyString, isPositiveNumber)
  create(name: string, price: number) {
    return `Product created: ${name} - $${price}`;  
  }
}

const product = new Product();

try {
  console.log(product.create("Laptop", 1200)); // Output: Product created: Laptop - $1200
  // product.create("", 0); // Throws an error
} catch (error:any) {
  console.error(error.message);
}

Пояснення:

• Валідатор isNotEmptyString перевіряє, чи не є рядок порожнім після видалення пробілів.
• Валідатор isPositiveNumber перевіряє, чи є значення додатним числом.
• Декоратор validate використовується для застосування обох валідаторів до методу create класу Product.

Найкращі практики використання декораторів для валідації параметрів

Ось кілька найкращих практик, які варто враховувати при використанні декораторів для валідації параметрів:

• Зберігайте декоратори простими: Декоратори повинні бути зосереджені на логіці валідації та уникати складних обчислень.
• Надавайте чіткі повідомлення про помилки: Переконайтеся, що повідомлення про помилки є інформативними та допомагають розробникам зрозуміти причини збоїв валідації.
• Використовуйте значущі імена: Вибирайте описові імена для своїх декораторів, щоб покращити читабельність коду.
• Документуйте свої декоратори: Документуйте призначення та використання ваших декораторів, щоб їх було легше зрозуміти та підтримувати.
• Враховуйте продуктивність: Хоча декоратори надають зручний спосіб додавання функціональності, пам'ятайте про їхній вплив на продуктивність, особливо в критичних до продуктивності додатках.
• Використовуйте TypeScript для покращеної типізації: TypeScript надає вбудовану підтримку декораторів та покращує безпеку типів, що полегшує розробку та підтримку логіки валідації на основі декораторів.
• Ретельно тестуйте свої декоратори: Пишіть юніт-тести, щоб переконатися, що ваші декоратори працюють коректно та належним чином обробляють різні сценарії.

Приклади з реального світу та випадки використання

Ось кілька прикладів з реального світу, як можна використовувати декоратори для валідації параметрів:

• Валідація запитів API: Декоратори можна використовувати для валідації вхідних параметрів запитів API, забезпечуючи їх відповідність очікуваним типам даних та форматам. Це запобігає непередбачуваній поведінці у вашій бекенд-логіці. Розглянемо сценарій, коли кінцева точка API очікує запит на реєстрацію користувача з такими параметрами, як username, email та password. Декоратори можна використовувати для перевірки наявності цих параметрів, їх правильного типу (рядок) та відповідності певним форматам (наприклад, валідація email-адреси за допомогою регулярного виразу).
• Валідація введених даних у формах: Декоратори можна використовувати для валідації полів введення у формах, забезпечуючи, що користувачі вводять коректні дані. Наприклад, перевірка, чи поле поштового індексу містить дійсний формат поштового індексу для певної країни.
• Валідація запитів до бази даних: Декоратори можна використовувати для валідації параметрів, що передаються в запити до бази даних, запобігаючи вразливостям SQL-ін'єкцій. Забезпечення належної санітизації даних, наданих користувачем, перед їх використанням у запиті до бази даних. Це може включати перевірку типів даних, довжини та форматів, а також екранування спеціальних символів для запобігання ін'єкції шкідливого коду.
• Валідація конфігураційних файлів: Декоратори можна використовувати для валідації налаштувань конфігураційних файлів, забезпечуючи, що вони знаходяться в допустимих діапазонах і мають правильний тип.
• Серіалізація/десеріалізація даних: Декоратори можна використовувати для валідації даних під час процесів серіалізації та десеріалізації, забезпечуючи цілісність даних та запобігаючи їх пошкодженню. Перевірка структури даних JSON перед їх обробкою, вимагаючи наявності обов'язкових полів, типів даних та форматів.

Порівняння декораторів з іншими техніками валідації

Хоча декоратори є потужним інструментом для валідації параметрів, важливо розуміти їхні сильні та слабкі сторони в порівнянні з іншими техніками валідації:

• Ручна валідація: Ручна валідація передбачає написання логіки валідації безпосередньо у функціях. Цей підхід може бути нудним і схильним до помилок, особливо для складних правил валідації. Декоратори пропонують більш декларативний та багаторазовий підхід.
• Бібліотеки для валідації: Бібліотеки для валідації надають набір готових функцій та правил валідації. Хоча ці бібліотеки можуть бути корисними, вони можуть бути не такими гнучкими або налаштовуваними, як декоратори. Бібліотеки, такі як Joi або Yup, чудово підходять для визначення схем для валідації цілих об'єктів, тоді як декоратори відмінно справляються з валідацією окремих параметрів.
• Проміжне програмне забезпечення (Middleware): Проміжне програмне забезпечення часто використовується для валідації запитів у веб-додатках. Хоча middleware підходить для валідації цілих запитів, декоратори можна використовувати для більш детальної валідації окремих параметрів функцій.

Висновок

Декоратори JavaScript надають потужний та елегантний спосіб реалізації валідації параметрів. Використовуючи декоратори, ви можете покращити читабельність коду, зменшити кількість шаблонного коду, підвищити можливість повторного використання коду та відокремити логіку валідації від основної бізнес-логіки. Незалежно від того, чи створюєте ви API, веб-додатки чи інші типи програмного забезпечення, декоратори можуть допомогти вам забезпечити цілісність даних та створити більш надійний та підтримуваний код.

Досліджуючи декоратори, пам'ятайте про дотримання найкращих практик, розгляд прикладів з реального світу та порівняння декораторів з іншими техніками валідації, щоб визначити найкращий підхід для ваших конкретних потреб. З глибоким розумінням декораторів та їх застосуванням у валідації параметрів, ви можете значно підвищити якість та надійність вашого коду JavaScript.

Крім того, зростаюче впровадження TypeScript, який пропонує нативну підтримку декораторів, робить цю техніку ще більш привабливою для сучасної розробки на JavaScript. Використання декораторів для валідації параметрів — це крок до написання чистіших, більш підтримуваних та надійніших додатків на JavaScript.